home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / os2 / ircdor14.zip / ircdoor.doc < prev    next >
Text File  |  1996-08-15  |  35KB  |  841 lines
  1.  
  2.  
  3. IRCDOOR 1.4 Manual
  4. Copyright (c) 1996 by Andrew Eigus
  5.  
  6.  
  7.                    Table of Contents
  8.  
  9.  
  10.             1.  ...Introduction
  11.  
  12.         2.  ...Software and Hardware requirements
  13.  
  14.         3.  ...License agreement
  15.  
  16.         4.  ...Disclaimer
  17.  
  18.         5.  ...Installation instructions
  19.  
  20.             6.  ...IRC commands supported by IRCDOOR/2
  21.  
  22.             7.  ...IRCDOOR/2-specific commands
  23.  
  24.         8.  ...Comments
  25.  
  26.             9.  ...Registration information
  27.  
  28.         10. ...IRCDOOR/2 distribution information
  29.  
  30.             11. ...Contact information
  31.  
  32.  
  33.  
  34.  
  35.  
  36.     1.    Introduction
  37.  
  38.     What is IRC?
  39.  
  40.     IRC stands for "Internet Relay Chat". It was originally
  41.     written by Jarkko Oikarinen (jto@tolsun.oulu.fi) in 1988.
  42.     Since starting in Finland, it has been used in over 60
  43.     countries around the world. It was designed as a replacement
  44.     for the "talk" program but has become much much more than
  45.     that. IRC is a multi-user chat system, where people convene
  46.     on "channels" (a virtual place, usually with a topic of
  47.     conversation) to talk in groups, or privately. IRC is
  48.     constantly evolving, so the way things to work one week may
  49.     not be the way they work the next. 
  50.  
  51.     Good, what is IRCDOOR?
  52.  
  53.     IRCDOOR/2 is an advanced 32-bit OS/2 Internet Relay Chat
  54.     client with main purpose of being able to be run from a BBS
  55.     (Bulletin Board System) as an external door program, that
  56.     would allow BBS users to IRC. Yes, it means that you could
  57.     *dramatically* increase your BBS popularity by adding IRC
  58.     service for your BBS users. Imagine a user who finds out
  59.     that something is much bigger, better and cooler than
  60.     a simple chat on BBS! Imagine a user who opens your Internet
  61.         service menu and starts a chat session on the Internet!
  62.  
  63.     The following is a brief list of features that are supported
  64.     in current version of IRCDOOR/2:
  65.  
  66.     -- natural 32-bit application capable of running simultaneously
  67.            at as many lines as you wish to register it for
  68.     -- as a BBS door supports TTY/ANSI interface
  69.     -- supports DORINFO1/DOORSYS drop-file formats
  70.     -- supports most standard IRCII 2.8 commands plus some
  71.        additional /CTCP-request commands and some specific
  72.        to IRCDOOR-only commands eg: /WHOELSE, /TIMELEFT, etc.
  73.     -- easy to setup (most options can be specified via command
  74.        line)
  75.     -- can be run in local mode too as a normal IRC client program
  76.     -- runs from any native OS/2 BBS that supports "hot" (open)
  77.        com port handles
  78.     -- flexible configuration
  79.     -- extensive Maximus BBS support (MEX code provided)
  80.     -- custom colors and other settings through config file
  81.     -- ability to be run from a DOS BBS (use Spawn program)
  82.  
  83.  
  84.  
  85.     2.    Software and Hardware requirements
  86.  
  87.     Requires IBM PC (80486 is recommended), Internet connection
  88.     via ethernet, SLIP/PPP etc., IBM OS/2 version 2.0 or 3.0 and
  89.     IBM IAK (Internet Access Kit) with 32-bit TCP/IP libraries
  90.     (files: TCP32DLL.DLL and and SO32DLL.DLL). The Ray Gwinn's
  91.     SIO FOSSIL driver is also recommended for better perfomance.
  92.     SIO is also necessary if you are going to run IRCDOOR from
  93.     a DOS based BBS.
  94.  
  95.  
  96.     3.    License agreement
  97.  
  98.     IRCDOOR/2 IS COPYRIGHT AND PROPERTY OF ANDREW EIGUS, AN
  99.     INDEPENDENT SOFTWARE DEVELOPER (FREELANCER). NONE OF THE
  100.     PORTIONS CONTAINED IN THE IRCDOOR/2 DISTRIBUTION PACKAGE CAN
  101.     BE RESELLED, MODIFIED, DISASSEMBLED OR REPRODUCED IN ANY WAY
  102.     WITHOUT THE AUTHOR'S PERMISSION. PERMISSION IS GRANTED TO
  103.     ANYONE TO DISTRIBUTE THE ENTIRE PACKAGE IN THE NON-MODIFIED
  104.     FORM, PROVIDED THAT ALL FILES ARE KEPT IN THE DISTRIBUTION
  105.     ARCHIVE.
  106.  
  107.     IRCDOOR/2 IS NEITHER PUBLIC DOMAIN, NOR FREEWARE. IRCDOOR IS
  108.     SHAREWARE SOFTWARE. YOU MAY EVALUATE IT FOR A TRIAL PERIOD OF
  109.         28 DAYS, AND THEN WHETHER REGISTER, OR DISCONTINUE USING IT. 
  110.  
  111.  
  112.     4.    Disclaimer
  113.  
  114.  
  115.     THIS SOFTWARE PROVIDED "AS-IS", WHICH MEANS THAT THERE IS
  116.     ABSOLUTELY NO WARRANTY PROVIDED BY THE AUTHOR. IN NO EVENT
  117.     THE AUTHOR WILL BE LIABLE TO YOU FOR ANY DAMAGES ARISING OUT
  118.     OF THE USE OF ANY PART OF THIS PROGRAM.
  119.  
  120.  
  121.     5.    Installation instructions
  122.  
  123.     Installation instructions are sub-divided in three sections.
  124.     Section 5.1 describes the door installation details for non-
  125.     Maximus BBS users, section 5.2 describes door installation
  126.         instructions for Maximus BBS, and sysops who are running a
  127.         DOS-based BBS under OS/2 should read sesction 5.3.
  128.  
  129.  
  130.     5.1    Installation for non-Maximus OS/2 BBS systems
  131.  
  132.     a) Create an empty subdirectory in your BBS [doors]
  133.        directory called IRCDOOR. Let's say i am using Lora BBS,
  134.        and a path to my door games is C:\LORA\DOORS\, so i
  135.        create a directory C:\LORA\DOORS\IRCDOOR.
  136.  
  137.     b) Unzip the distribution IRCDOOR archive to that directory,
  138.        so it would contain AT LEAST the following files:
  139.  
  140.             IRCDOOR.EXE
  141.        IRCDOOR.CFG
  142.             IRCDOOR.HLP
  143.  
  144.     c) Next, set up your BBS software for this door to be run; use
  145.        either DOOR.SYS (recommended) or DORINFO?.DEF format drop-
  146.        file. It should be created prior to running IRCDOOR by your
  147.        BBS software (see your BBS manual for details). Your BBS
  148.        software might be able to pass some information to IRCDOOR
  149.        via command-line: IRC server name, port number, etc. Even
  150.        some parameters in the drop-file can be overriden through
  151.        a command-line. See command-line switches in the Comments
  152.        section for more information about IRCDOOR/2 command line
  153.        parameters.
  154.  
  155.           Your BBS software MUST be able to pass an open com port
  156.        "handle" parameter to IRCDOOR. IRCDOOR will NOT work in
  157.        the remote mode without port handle and BBS drop file path
  158.        specified as command-line arguments. (see -p and -d options
  159.        in the command line parameters paragraph). I recommend you
  160.        to create an OS/2 command file, for example IRCDOOR.CMD,
  161.           that will run the door. Here is sample command file:
  162.  
  163.  
  164.            @echo off
  165.            cd \lora\doors\ircdoor
  166.            if "%1"=="" goto local
  167.            if "%1"=="0" goto local
  168.  
  169.            :remote
  170.        rem *** change the path below to specify a path to YOUR
  171.        rem *** drop file. In multinode environments, this usually
  172.        rem *** depends on a node number.
  173.            ircdoor -p%1 -dc:\lora\node%2\door.sys -k%2 -sirc.funet.fi -$6666
  174.            goto quit
  175.  
  176.            :local
  177.            ircdoor -l -uSysOp -nSysOp -r"My Name" -sirc.funet.fi $6666
  178.            goto quit
  179.  
  180.            :quit
  181.            cd \lora
  182.  
  183.         This small command file above will do the job. It requires
  184.        two arguments: 1 - "hot" com port handle and 2 - BBS node
  185.        number. The node number will be used to specify a target
  186.            directory (path) for/to a drop file. IRCDOOR will automatically
  187.            determine drop file type by it's name. See command line
  188.            switches for more information.
  189.  
  190.     d) Edit your STARTUP.CMD file in your system root directory
  191.        and add there the following line:
  192.  
  193.         erase c:\ircdoor_home_directory\nodeinfo.* >nul
  194.  
  195.        This command will erase old node information files from the
  196.        IRCDOOR home directory. Ircdoor_home_directory must be
  197.        replaced with the directory name where IRCDOOR/2 files are
  198.        located.
  199.  
  200.        IRCDOOR/2 creates and uses nodeinfo.* files in it's home
  201.        directory and it automatically deletes them when a user
  202.        exits the door. But if you encounter a system crash during
  203.        the time when IRCDOOR is running, you should manually
  204.        remove nodeinfo.* files from it's home directory to prevent
  205.        IRCDOOR from thinking that it is running at the moment.
  206.        That's why the best way to avoid this is to insert that
  207.        mentioned erase command above to your STARTUP.CMD file so
  208.        whenever your system reboots, old IRCDOOR node information
  209.        files will be deleted.
  210.  
  211.     There are many different types of BBS software for OS/2, and
  212.     most support passing various parameters via command line, and
  213.     most are able to write standard BBS drop-files (DOOR.SYS or
  214.     DORINFO?.DEF). If this is not your case, and you are
  215.     experiencing problems on how to setup a door, please contact
  216.     me at the address given at the bottom of this document. If
  217.     you own a DOS BBS, please see paragraph 5.3, which describes
  218.     how to setup IRCDOOR